ObtainNewCertificate(IEasyUAClientServerApplication,UAObtainCertificateArguments,IProgress<String[]>,CancellationToken) Method

Obtains a new application own certificate from the certificate manager, and stores it for subsequent usage.

Syntax

Visual Basic
C#
C++/CLI

'Declaration
 
<ExtensionAttribute()>
<NotNullAttribute()>
Public Overloads Shared Function ObtainNewCertificate( _
   ByVal application As IEasyUAClientServerApplication, _
   ByVal arguments As UAObtainCertificateArguments, _
   ByVal progress As IProgress(Of String()), _
   ByVal cancellationToken As CancellationToken _
) As IPkiCertificate

'Usage
 
Dim application As IEasyUAClientServerApplication
Dim arguments As UAObtainCertificateArguments
Dim progress As IProgress(Of String())
Dim cancellationToken As CancellationToken
Dim value As IPkiCertificate
 
value = IEasyUAClientServerApplicationExtension.ObtainNewCertificate(application, arguments, progress, cancellationToken)

[Extension()]
[NotNull()]
public static IPkiCertificate ObtainNewCertificate( 
   IEasyUAClientServerApplication application,
   UAObtainCertificateArguments arguments,
   IProgress<string[]> progress,
   CancellationToken cancellationToken
)

[Extension()]
[NotNull()]
public:
static IPkiCertificate^ ObtainNewCertificate( 
   IEasyUAClientServerApplication^ application,
   UAObtainCertificateArguments^ arguments,
   IProgress<array<String^>>^ progress,
   CancellationToken cancellationToken
)

Parameters

application: The OPC UA client/server application object that will perform the operation.
arguments: The arguments describing how the certificate should be obtained.
progress: A provider for progress updates.
cancellationToken: A cancellation token for canceling the operation.

Return Value

Returns the certificate obtained from the certificate manager.

Exceptions

Exception Description

Exception	Description
System.ArgumentNullException	A `null` reference (`Nothing` in Visual Basic) is passed to a method that does not accept it as a valid argument. This is a usage error, i.e. it will never occur (the exception will not be thrown) in a correctly written program. Your code should not catch this exception.
System.OperationCanceledException	An operation that the thread was execution has been cancelled.
OpcLabs.EasyOpc.UA.OperationModel.UAException	The OPC UA operation has failed. This operation exception in uniformly used to allow common handling of various kinds of errors. The System.Exception.InnerException always contains information about the actual error cause. This is an operation error that depends on factors external to your program, and thus cannot be always avoided. Your code must handle it appropriately.

System.ArgumentNullException

A null reference (Nothing in Visual Basic) is passed to a method that does not accept it as a valid argument.

This is a usage error, i.e. it will never occur (the exception will not be thrown) in a correctly written program. Your code should not catch this exception.

System.OperationCanceledException An operation that the thread was execution has been cancelled.

OpcLabs.EasyOpc.UA.OperationModel.UAException

The OPC UA operation has failed. This operation exception in uniformly used to allow common handling of various kinds of errors. The System.Exception.InnerException always contains information about the actual error cause.

This is an operation error that depends on factors external to your program, and thus cannot be always avoided. Your code must handle it appropriately.

Remarks

The operation is synchronous. It can take considerable time to execute, because it involves multiple steps, and waiting for a finalization of the request by the GDS (see the OpcLabs.EasyOpc.UA.Gds.IEasyUACertificateManagement.FinishRequest method).

For an alternative based on asynchronous programming model (APM, System.IAsyncResult) pattern, see the BeginObtainNewCertificate method and related extension methods.

For a task-based asynchronous programming pattern alternative, see the ObtainNewCertificateAsync(IEasyUAClientServerApplication,UAEndpointDescriptor) extension method and its overloads.

Requirements

Target Platforms: .NET Framework: Windows 10 (selected versions), Windows 11 (selected versions), Windows Server 2016, Windows Server 2022; .NET: Linux, macOS, Microsoft Windows

Reference

IEasyUAClientServerApplicationExtension Class
IEasyUAClientServerApplicationExtension Members
Overload List

Send Documentation Feedback. Technical Support